notiflows 0.0.1

data/rbi/notiflows/models/user_upsert_params.rbi

@@ -0,0 +1,203 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    class UserUpsertParams < Notiflows::Internal::Type::BaseModel
+      extend Notiflows::Internal::Type::RequestParameters::Converter
+      include Notiflows::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Notiflows::UserUpsertParams, Notiflows::Internal::AnyHash)
+        end
+
+      # Your system's unique identifier for this user. Required for creating new users.
+      sig { returns(String) }
+      attr_accessor :external_id
+
+      # URL to user's avatar image (must start with http:// or https://)
+      sig { returns(T.nilable(String)) }
+      attr_reader :avatar
+
+      sig { params(avatar: String).void }
+      attr_writer :avatar
+
+      # Initial channel settings (e.g., device tokens for push)
+      sig do
+        returns(
+          T.nilable(T::Array[Notiflows::UserUpsertParams::ChannelSetting])
+        )
+      end
+      attr_reader :channel_settings
+
+      sig do
+        params(
+          channel_settings:
+            T::Array[Notiflows::UserUpsertParams::ChannelSetting::OrHash]
+        ).void
+      end
+      attr_writer :channel_settings
+
+      # Custom attributes. Deep-merged with existing values on update.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :custom_fields
+
+      sig { params(custom_fields: T.anything).void }
+      attr_writer :custom_fields
+
+      # User's email address
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
+
+      # User's first name
+      sig { returns(T.nilable(String)) }
+      attr_reader :first_name
+
+      sig { params(first_name: String).void }
+      attr_writer :first_name
+
+      # User's last name
+      sig { returns(T.nilable(String)) }
+      attr_reader :last_name
+
+      sig { params(last_name: String).void }
+      attr_writer :last_name
+
+      # BCP 47 locale code (e.g., en-US, es-ES, fr-FR)
+      sig { returns(T.nilable(String)) }
+      attr_reader :locale
+
+      sig { params(locale: String).void }
+      attr_writer :locale
+
+      # User's phone number in E.164 format
+      sig { returns(T.nilable(String)) }
+      attr_reader :phone
+
+      sig { params(phone: String).void }
+      attr_writer :phone
+
+      # Request body for updating user preferences. Only provided fields are updated.
+      sig { returns(T.nilable(::Notiflows::Users::UpdatePreferencesRequest)) }
+      attr_reader :preferences
+
+      sig do
+        params(
+          preferences: ::Notiflows::Users::UpdatePreferencesRequest::OrHash
+        ).void
+      end
+      attr_writer :preferences
+
+      # IANA timezone (e.g., America/New_York, Europe/London)
+      sig { returns(T.nilable(String)) }
+      attr_reader :timezone
+
+      sig { params(timezone: String).void }
+      attr_writer :timezone
+
+      sig do
+        params(
+          external_id: String,
+          avatar: String,
+          channel_settings:
+            T::Array[Notiflows::UserUpsertParams::ChannelSetting::OrHash],
+          custom_fields: T.anything,
+          email: String,
+          first_name: String,
+          last_name: String,
+          locale: String,
+          phone: String,
+          preferences: ::Notiflows::Users::UpdatePreferencesRequest::OrHash,
+          timezone: String,
+          request_options: Notiflows::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Your system's unique identifier for this user. Required for creating new users.
+        external_id:,
+        # URL to user's avatar image (must start with http:// or https://)
+        avatar: nil,
+        # Initial channel settings (e.g., device tokens for push)
+        channel_settings: nil,
+        # Custom attributes. Deep-merged with existing values on update.
+        custom_fields: nil,
+        # User's email address
+        email: nil,
+        # User's first name
+        first_name: nil,
+        # User's last name
+        last_name: nil,
+        # BCP 47 locale code (e.g., en-US, es-ES, fr-FR)
+        locale: nil,
+        # User's phone number in E.164 format
+        phone: nil,
+        # Request body for updating user preferences. Only provided fields are updated.
+        preferences: nil,
+        # IANA timezone (e.g., America/New_York, Europe/London)
+        timezone: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            external_id: String,
+            avatar: String,
+            channel_settings:
+              T::Array[Notiflows::UserUpsertParams::ChannelSetting],
+            custom_fields: T.anything,
+            email: String,
+            first_name: String,
+            last_name: String,
+            locale: String,
+            phone: String,
+            preferences: ::Notiflows::Users::UpdatePreferencesRequest,
+            timezone: String,
+            request_options: Notiflows::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class ChannelSetting < Notiflows::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::UserUpsertParams::ChannelSetting,
+              Notiflows::Internal::AnyHash
+            )
+          end
+
+        # Channel ID
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # Provider-specific settings
+        sig { returns(T.anything) }
+        attr_accessor :settings
+
+        sig do
+          params(channel_id: String, settings: T.anything).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Channel ID
+          channel_id:,
+          # Provider-specific settings
+          settings:
+        )
+        end
+
+        sig { override.returns({ channel_id: String, settings: T.anything }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/channel_setting_delete_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class ChannelSettingDeleteParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::ChannelSettingDeleteParams,
+              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/channel_setting_retrieve_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class ChannelSettingRetrieveParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::ChannelSettingRetrieveParams,
+              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/channel_setting_update_params.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class ChannelSettingUpdateParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::ChannelSettingUpdateParams,
+              Notiflows::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :user_external_id
+
+        # Provider-specific settings. Structure depends on channel provider.
+        sig do
+          returns(
+            T.any(
+              Notiflows::Users::MobilePushSettings,
+              Notiflows::Users::SlackSettings
+            )
+          )
+        end
+        attr_accessor :settings
+
+        sig do
+          params(
+            user_external_id: String,
+            settings:
+              T.any(
+                Notiflows::Users::MobilePushSettings::OrHash,
+                Notiflows::Users::SlackSettings::OrHash
+              ),
+            request_options: Notiflows::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          user_external_id:,
+          # Provider-specific settings. Structure depends on channel provider.
+          settings:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              user_external_id: String,
+              settings:
+                T.any(
+                  Notiflows::Users::MobilePushSettings,
+                  Notiflows::Users::SlackSettings
+                ),
+              request_options: Notiflows::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Provider-specific settings. Structure depends on channel provider.
+        module Settings
+          extend Notiflows::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Notiflows::Users::MobilePushSettings,
+                Notiflows::Users::SlackSettings
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Notiflows::Users::ChannelSettingUpdateParams::Settings::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/channel_settings.rbi

@@ -0,0 +1,156 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class UsersChannelSettings < Notiflows::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::UsersChannelSettings,
+              Notiflows::Internal::AnyHash
+            )
+          end
+
+        # Channel ID
+        sig { returns(String) }
+        attr_accessor :channel_id
+
+        # When the settings were created
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The provider type for this channel
+        sig do
+          returns(
+            Notiflows::Users::UsersChannelSettings::Provider::TaggedSymbol
+          )
+        end
+        attr_accessor :provider
+
+        # Provider-specific settings. See MobilePushSettings or SlackSettings schemas.
+        sig do
+          returns(Notiflows::Users::UsersChannelSettings::Settings::Variants)
+        end
+        attr_accessor :settings
+
+        # When the settings were last updated
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # Internal user ID
+        sig { returns(String) }
+        attr_accessor :user_id
+
+        # User's settings for a specific channel (e.g., device tokens, Slack credentials)
+        sig do
+          params(
+            channel_id: String,
+            created_at: Time,
+            provider:
+              Notiflows::Users::UsersChannelSettings::Provider::OrSymbol,
+            settings:
+              T.any(
+                Notiflows::Users::MobilePushSettings::OrHash,
+                Notiflows::Users::SlackSettings::OrHash
+              ),
+            updated_at: Time,
+            user_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Channel ID
+          channel_id:,
+          # When the settings were created
+          created_at:,
+          # The provider type for this channel
+          provider:,
+          # Provider-specific settings. See MobilePushSettings or SlackSettings schemas.
+          settings:,
+          # When the settings were last updated
+          updated_at:,
+          # Internal user ID
+          user_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              channel_id: String,
+              created_at: Time,
+              provider:
+                Notiflows::Users::UsersChannelSettings::Provider::TaggedSymbol,
+              settings:
+                Notiflows::Users::UsersChannelSettings::Settings::Variants,
+              updated_at: Time,
+              user_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The provider type for this channel
+        module Provider
+          extend Notiflows::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Notiflows::Users::UsersChannelSettings::Provider)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          APNS =
+            T.let(
+              :apns,
+              Notiflows::Users::UsersChannelSettings::Provider::TaggedSymbol
+            )
+          FCM =
+            T.let(
+              :fcm,
+              Notiflows::Users::UsersChannelSettings::Provider::TaggedSymbol
+            )
+          SLACK =
+            T.let(
+              :slack,
+              Notiflows::Users::UsersChannelSettings::Provider::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Notiflows::Users::UsersChannelSettings::Provider::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Provider-specific settings. See MobilePushSettings or SlackSettings schemas.
+        module Settings
+          extend Notiflows::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Notiflows::Users::MobilePushSettings,
+                Notiflows::Users::SlackSettings
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[
+                Notiflows::Users::UsersChannelSettings::Settings::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/notiflows/models/users/delivery_list_params.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class DeliveryListParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::DeliveryListParams,
+              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 channel ID (UUID)
+        sig { returns(T.nilable(String)) }
+        attr_reader :channel_id
+
+        sig { params(channel_id: String).void }
+        attr_writer :channel_id
+
+        # 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 (pending, sent, failed)
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        # Filter by topic name
+        sig { returns(T.nilable(String)) }
+        attr_reader :topic
+
+        sig { params(topic: String).void }
+        attr_writer :topic
+
+        sig do
+          params(
+            after: String,
+            before: String,
+            channel_id: 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 channel ID (UUID)
+          channel_id: 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 (pending, sent, failed)
+          status: nil,
+          # Filter by topic name
+          topic: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              after: String,
+              before: String,
+              channel_id: 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/delivery_retrieve_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Notiflows
+  module Models
+    module Users
+      class DeliveryRetrieveParams < Notiflows::Internal::Type::BaseModel
+        extend Notiflows::Internal::Type::RequestParameters::Converter
+        include Notiflows::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Notiflows::Users::DeliveryRetrieveParams,
+              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