notiflows 0.0.1

data/rbi/notiflows/models/users/mobile_push_settings.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class MobilePushSettings < Notiflows::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::MobilePushSettings,
+              Notiflows::Internal::AnyHash
+            )
+          end
+
+        # List of device tokens for push notifications. At least one token is required.
+        sig { returns(T::Array[String]) }
+        attr_accessor :device_tokens
+
+        # Settings for mobile push notifications (APNS/FCM)
+        sig do
+          params(device_tokens: T::Array[String]).returns(T.attached_class)
+        end
+        def self.new(
+          # List of device tokens for push notifications. At least one token is required.
+          device_tokens:
+        )
+        end
+
+        sig { override.returns({ device_tokens: T::Array[String] }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/notification_list_params.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class NotificationListParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::NotificationListParams,
+              Notiflows::Internal::AnyHash
+            )
+          end
+
+        # Cursor for fetching the next page
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
+        # Cursor for fetching the previous page
+        sig { returns(T.nilable(String)) }
+        attr_reader :before
+
+        sig { params(before: String).void }
+        attr_writer :before
+
+        # Filter by created after (ISO 8601 datetime)
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_after
+
+        sig { params(created_after: String).void }
+        attr_writer :created_after
+
+        # Filter by created before (ISO 8601 datetime)
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_before
+
+        sig { params(created_before: String).void }
+        attr_writer :created_before
+
+        # Number of items per page (default: 25, max: 1000)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # Filter by status
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        # Filter by topic
+        sig { returns(T.nilable(String)) }
+        attr_reader :topic
+
+        sig { params(topic: String).void }
+        attr_writer :topic
+
+        sig do
+          params(
+            after: String,
+            before: String,
+            created_after: String,
+            created_before: String,
+            limit: Integer,
+            status: String,
+            topic: String,
+            request_options: Notiflows::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Cursor for fetching the next page
+          after: nil,
+          # Cursor for fetching the previous page
+          before: nil,
+          # Filter by created after (ISO 8601 datetime)
+          created_after: nil,
+          # Filter by created before (ISO 8601 datetime)
+          created_before: nil,
+          # Number of items per page (default: 25, max: 1000)
+          limit: nil,
+          # Filter by status
+          status: nil,
+          # Filter by topic
+          topic: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              after: String,
+              before: String,
+              created_after: String,
+              created_before: String,
+              limit: Integer,
+              status: String,
+              topic: String,
+              request_options: Notiflows::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/notification_retrieve_params.rbi

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

data/rbi/notiflows/models/users/preference_retrieve_params.rbi

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

data/rbi/notiflows/models/users/preference_update_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class PreferenceUpdateParams < ::Notiflows::Models::Users::UpdatePreferencesRequest
+        extend ::Notiflows::Internal::Type::RequestParameters::Converter
+        include ::Notiflows::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ::Notiflows::Users::PreferenceUpdateParams,
+              ::Notiflows::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: Notiflows::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig do
+          override.returns({ request_options: ::Notiflows::RequestOptions })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/preferences.rbi

@@ -0,0 +1,241 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class UsersPreferences < ::Notiflows::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ::Notiflows::Users::UsersPreferences,
+              ::Notiflows::Internal::AnyHash
+            )
+          end
+
+        # Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+        # opted out.
+        sig do
+          returns(T.nilable(::Notiflows::Users::UsersPreferences::ChannelTypes))
+        end
+        attr_reader :channel_types
+
+        sig do
+          params(
+            channel_types:
+              ::Notiflows::Users::UsersPreferences::ChannelTypes::OrHash
+          ).void
+        end
+        attr_writer :channel_types
+
+        # Per-notiflow preferences. Keys are notiflow IDs (UUIDs).
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[Symbol, ::Notiflows::Users::UsersPreferences::Notiflow]
+            )
+          )
+        end
+        attr_reader :notiflows
+
+        sig do
+          params(
+            notiflows:
+              T::Hash[
+                Symbol,
+                ::Notiflows::Users::UsersPreferences::Notiflow::OrHash
+              ]
+          ).void
+        end
+        attr_writer :notiflows
+
+        # User notification preferences
+        sig do
+          params(
+            channel_types:
+              ::Notiflows::Users::UsersPreferences::ChannelTypes::OrHash,
+            notiflows:
+              T::Hash[
+                Symbol,
+                ::Notiflows::Users::UsersPreferences::Notiflow::OrHash
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+          # opted out.
+          channel_types: nil,
+          # Per-notiflow preferences. Keys are notiflow IDs (UUIDs).
+          notiflows: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              channel_types: ::Notiflows::Users::UsersPreferences::ChannelTypes,
+              notiflows:
+                T::Hash[Symbol, ::Notiflows::Users::UsersPreferences::Notiflow]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class ChannelTypes < ::Notiflows::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ::Notiflows::Users::UsersPreferences::ChannelTypes,
+                ::Notiflows::Internal::AnyHash
+              )
+            end
+
+          # Chat notifications (Slack, etc.)
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :chat
+
+          sig { params(chat: T::Boolean).void }
+          attr_writer :chat
+
+          # Email notifications
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :email
+
+          sig { params(email: T::Boolean).void }
+          attr_writer :email
+
+          # In-app feed notifications
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :in_app
+
+          sig { params(in_app: T::Boolean).void }
+          attr_writer :in_app
+
+          # Mobile push notifications (iOS/Android)
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :mobile_push
+
+          sig { params(mobile_push: T::Boolean).void }
+          attr_writer :mobile_push
+
+          # SMS notifications
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :sms
+
+          sig { params(sms: T::Boolean).void }
+          attr_writer :sms
+
+          # Web push notifications
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :web_push
+
+          sig { params(web_push: T::Boolean).void }
+          attr_writer :web_push
+
+          # Global opt-in/opt-out settings per channel type. `true` = enabled, `false` =
+          # opted out.
+          sig do
+            params(
+              chat: T::Boolean,
+              email: T::Boolean,
+              in_app: T::Boolean,
+              mobile_push: T::Boolean,
+              sms: T::Boolean,
+              web_push: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Chat notifications (Slack, etc.)
+            chat: nil,
+            # Email notifications
+            email: nil,
+            # In-app feed notifications
+            in_app: nil,
+            # Mobile push notifications (iOS/Android)
+            mobile_push: nil,
+            # SMS notifications
+            sms: nil,
+            # Web push notifications
+            web_push: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                chat: T::Boolean,
+                email: T::Boolean,
+                in_app: T::Boolean,
+                mobile_push: T::Boolean,
+                sms: T::Boolean,
+                web_push: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Notiflow < ::Notiflows::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ::Notiflows::Users::UsersPreferences::Notiflow,
+                ::Notiflows::Internal::AnyHash
+              )
+            end
+
+          # Channel-specific overrides for this notiflow
+          sig { returns(T.nilable(T::Hash[Symbol, T::Boolean])) }
+          attr_reader :channel_types
+
+          sig { params(channel_types: T::Hash[Symbol, T::Boolean]).void }
+          attr_writer :channel_types
+
+          # Whether this notiflow is enabled for the user
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :enabled
+
+          sig { params(enabled: T::Boolean).void }
+          attr_writer :enabled
+
+          # Notiflow name (read-only, for display)
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          sig do
+            params(
+              channel_types: T::Hash[Symbol, T::Boolean],
+              enabled: T::Boolean,
+              name: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Channel-specific overrides for this notiflow
+            channel_types: nil,
+            # Whether this notiflow is enabled for the user
+            enabled: nil,
+            # Notiflow name (read-only, for display)
+            name: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                channel_types: T::Hash[Symbol, T::Boolean],
+                enabled: T::Boolean,
+                name: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/slack_settings.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class SlackSettings < Notiflows::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Notiflows::Users::SlackSettings, Notiflows::Internal::AnyHash)
+          end
+
+        # Slack channel ID (starts with C)
+        sig { returns(T.nilable(String)) }
+        attr_reader :slack_channel_id
+
+        sig { params(slack_channel_id: String).void }
+        attr_writer :slack_channel_id
+
+        # Slack user ID for direct messages (starts with U)
+        sig { returns(T.nilable(String)) }
+        attr_reader :slack_user_id
+
+        sig { params(slack_user_id: String).void }
+        attr_writer :slack_user_id
+
+        # Settings for Slack notifications. At least one of `slack_channel_id` or
+        # `slack_user_id` must be provided.
+        sig do
+          params(slack_channel_id: String, slack_user_id: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Slack channel ID (starts with C)
+          slack_channel_id: nil,
+          # Slack user ID for direct messages (starts with U)
+          slack_user_id: nil
+        )
+        end
+
+        sig do
+          override.returns({ slack_channel_id: String, slack_user_id: String })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/subscription.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class Subscription < Notiflows::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Notiflows::Users::Subscription, Notiflows::Internal::AnyHash)
+          end
+
+        # Subscription ID
+        sig { returns(String) }
+        attr_accessor :id
+
+        # When the subscription was created
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Name of the subscribed topic
+        sig { returns(String) }
+        attr_accessor :topic_name
+
+        # User's internal ID
+        sig { returns(String) }
+        attr_accessor :user_id
+
+        # A user's subscription to a topic
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            topic_name: String,
+            user_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Subscription ID
+          id:,
+          # When the subscription was created
+          created_at:,
+          # Name of the subscribed topic
+          topic_name:,
+          # User's internal ID
+          user_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              topic_name: String,
+              user_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/subscription_list_params.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class SubscriptionListParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::SubscriptionListParams,
+              Notiflows::Internal::AnyHash
+            )
+          end
+
+        # Cursor for fetching the next page
+        sig { returns(T.nilable(String)) }
+        attr_reader :after
+
+        sig { params(after: String).void }
+        attr_writer :after
+
+        # Cursor for fetching the previous page
+        sig { returns(T.nilable(String)) }
+        attr_reader :before
+
+        sig { params(before: String).void }
+        attr_writer :before
+
+        # Filter by created after (ISO 8601 datetime)
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_after
+
+        sig { params(created_after: String).void }
+        attr_writer :created_after
+
+        # Filter by created before (ISO 8601 datetime)
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_before
+
+        sig { params(created_before: String).void }
+        attr_writer :created_before
+
+        # Number of items per page (default: 25, max: 1000)
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        sig do
+          params(
+            after: String,
+            before: String,
+            created_after: String,
+            created_before: String,
+            limit: Integer,
+            request_options: Notiflows::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Cursor for fetching the next page
+          after: nil,
+          # Cursor for fetching the previous page
+          before: nil,
+          # Filter by created after (ISO 8601 datetime)
+          created_after: nil,
+          # Filter by created before (ISO 8601 datetime)
+          created_before: nil,
+          # Number of items per page (default: 25, max: 1000)
+          limit: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              after: String,
+              before: String,
+              created_after: String,
+              created_before: String,
+              limit: Integer,
+              request_options: Notiflows::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end